Inside Macintosh: Programming With the Text Encoding Conversion Manager /

Chapter 3 - Text Encoding Converter Reference / Text Encoding Converter Functions

Multiple Encoding Run Conversions /

TECGetEncodingList

Gets the list of destination encodings specified in TECCreateOneToManyConverter.

pascal OSStatus TECGetEncodingList(
                     TECObjectRef encodingConverter, 
                     ItemCount *numEncodings, 
                     Handle *encodingList
                     );

encodingConverter

A reference to the text encoding conversion object returned by the TECCreateOneToManyConverter (page 99) function.

numEncodings

A pointer to a value of type ItemCount. On return, this value indicates the number of encodings specified by the encodingList handle.

encodingList

A handle to an array of text encoding specifications. On return, encodingList contains an array of destination text encoding specifications that the converter object can convert to. The memory is allocated by the Text Encoding Converter.

function result

A result code. See "Text Encoding Conversion Manager Result Codes" (page 42) for a list of possible values.

DISCUSSION

The TECGetEncodingList function returns a list of destination encodings from a converter object created by TECCreateOneToManyConverter (page 99). The function returns the number of destination encodings and a handle to an array of text encoding specifications.

IMPORTANT

The TECDisposeConverter function automatically disposes of the handle, so you do not need to do so yourself. This also means that you should not attempt to reference the handle after you have disposed of the converter object.

Plug-ins that handle one-to-many conversions use the TECGetEncodingList function to get the output encoding list from the converter object reference.

SEE ALSO

The function TECDisposeConverter (page 93)